/* libwatopt++ - Optimization Toolkit
 *
 * Copyright (c) 2007 Christopher Alexander Watford
 * <christopher.watford@gmail.com>
 *
 * Permission is hereby granted, free of charge, to any person obtaining a copy
 * of this software and associated documentation files (the "Software"), to
 * deal in the Software without restriction, including without limitation the
 * rights to use, copy, modify, merge, publish, distribute, sublicense, and/or
 * sell copies of the Software, and to permit persons to whom the Software is
 * furnished to do so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included in
 * all copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
 * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS
 * IN THE SOFTWARE.
 *
 * $Id: sa.hpp 2 2007-05-06 18:01:15Z christopher.watford $
 */

#if _MSC_VER > 1000
#pragma once
#endif /* _MSC_VER > 1000 */

#ifndef _SA_HPP_
#define _SA_HPP_

#include <opt.hpp>

namespace watopt
{

   class IAnnealingSchedule
   {
   public:
	   virtual double Step(size_t step, double temp, size_t maxStep, double maxTemp) const = 0;
   };

   class ISimulatedAnnealingInstrumentation
   {
   public:
      virtual void Start() = 0;
      virtual void BeforeSelect(size_t step, double temp, double best) = 0;
      virtual void AfterSelect(size_t step, double temp, double best, double current, bool accepted) = 0;
      virtual void Stop(double best) = 0;
   };

   class SimulatedAnnealingOpt : public IOptimizer
   {
   public:
	   SimulatedAnnealingOpt(double startTemp, size_t maxSteps, IAnnealingSchedule* sched, bool localOpt = false);
	   virtual ~SimulatedAnnealingOpt(void);
   	
	   virtual void Initialize(IFitnessImplementation* guess);
	   virtual IFitnessImplementation* Solve(void);
      virtual void GetSolutions(std::vector<IFitnessImplementation*>& solutions) const;

      void SetInstrumentation(ISimulatedAnnealingInstrumentation* instrument) { _m_Instrument = instrument; }
      ISimulatedAnnealingInstrumentation* GetInstrumentation(void) const { return _m_Instrument; }

	   size_t StepsToBest(void) const { return _m_LastSteps; }
	   size_t MesaAccepts(void) const { return _m_MesaAccepts; }
	   size_t GoodAccepts(void) const { return _m_GoodAccepts; }
	   size_t BadAccepts(void) const { return _m_BadAccepts; }
	   double FinalTemp(void) const { return _m_LastTemp; }

   protected:
      ISimulatedAnnealingInstrumentation* _m_Instrument;

   private:
	   IFitnessImplementation* _m_Best;
      bool              _m_LocalOpt;
	   double				_m_Temp;
	   size_t				_m_MaxSteps;
	   IAnnealingSchedule*	_m_Schedule;

	   size_t				_m_LastSteps;
	   size_t				_m_BadAccepts;
	   size_t				_m_MesaAccepts;
	   size_t				_m_GoodAccepts;
	   double				_m_LastTemp;
   };
}

#endif /* !defined(_SA_HPP_) */